Description

This PR adds EIS prediction methods as presented in https://github.com/rish31415/pybamm-eis and https://github.com/pybamm-team/pybamm-eis. These methods are reimplemented into pybop to align with our model and problem classes. This PR also aligns the dataset requirements for "Time" across the codebase, as the EIS problem is in the frequency domain.

To be completed:

• EIS model construction should happen alongside the conventional pybop model
• Add "Contact resistance [Ohm]" addition to the terminal voltage variable
• Add plotting methods
• Improve the integration with conventional model call structure problem.evaluate-> model.simulate (i.e. do we need the additional class EISProblem and method model.simulateEIS())
• Add model.simulateEIS_S1 method w/ new name This requires reconstructing the sensitivities, as such is left for a future PR.
• Add eis functionality to model.predict()
• Add unit and integration tests
• Add fitting examples

This PR needs to be merged after PyBaMM v24.5 is released, as well as after #313

Issue reference

Fixes #269

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

• Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
• Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

• New Feature: A non-breaking change that adds new functionality.
• Optimization: A code change that improves performance.
• Examples: A change to existing or additional examples.
• Bug Fix: A non-breaking change that addresses an issue.
• Documentation: Updates to documentation or new documentation for new features.
• Refactoring: Non-functional changes that improve the codebase.
• Style: Non-functional changes related to code style (formatting, naming, etc).
• Testing: Additional tests to improve coverage or confirm functionality.
• Other: (Insert description of change)

Key checklist:

• No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All unit tests pass: $ nox -s tests
• The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

• Code is well-commented, especially in complex or unclear areas.
• Added tests that prove my fix is effective or that my feature works.
• Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.